home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / Tools / linuxdoc-sgml-1.1 / README < prev    next >
Text File  |  1995-05-03  |  2KB  |  34 lines
  1. This is Linuxdoc-SGML, a system for formatting documents, using SGML.
  2. As the name implies it is intended for Linux documentation, although it
  3. is applicable to various types of software documentation. Right now,
  4. Linuxdoc-SGML will produce either LaTeX or groff (for plain ASCII) code
  5. from a single SGML source file that you write. SGML is a generalized system
  6. for converting to other text-formatting languages, so HTML and texinfo
  7. support are forthcoming. Using Linuxdoc-SGML will let you produce many
  8. different formats of documentation from a single source. It is simple enough
  9. to be used for FAQs, HOWTOs, and other docs as well.
  10.  
  11. The file doc/guide.sgml is SGML source for the User's Guide. As you 
  12. probably don't know how to format it yet, there is formatted plain ASCII
  13. in doc/guide.txt. There's also guide.dvi and guide.ps, if you wish to
  14. print them instead. The first thing you should read is doc/guide.txt, 
  15. which explains how to install the software, and how to start writing 
  16. documents with it. The file doc/example.sgml is a simple example document
  17. which you can use as a tutorial. 
  18.  
  19. For real-life examples of uses of Linuxdoc-SGML, look at the Linux HOWTOs 
  20. on ftp.cs.cornell.edu:/pub/mdw/HOWTO. These HOWTOs are written in SGML 
  21. and automatically translated into LaTeX and nroff (and subsequently plain 
  22. ASCII) using this system. 
  23.  
  24. Please send me any questions or bug reports, as well as suggestions for
  25. improvement. Specifically, if you're using Linuxdoc-SGML to write Linux
  26. documentation, and would like to see a particular feature added or changed, 
  27. please get in touch with me. In this way Linuxdoc-SGML can be quasi-standard
  28. for Linux documentation, and any documents written in it can be formatted
  29. using the same software. 
  30.  
  31. Share and enjoy,
  32.  
  33. Matt Welsh, mdw@cs.cornell.edu
  34.